Skip to content

Conversation

@ritwik-g
Copy link
Contributor

Changes Made

Logging System Implementation

  • Add HelmLogger class for standardized logging
  • Update PathData and Value classes to use HelmLogger
  • Add comprehensive unit tests for logging
  • Add logging system documentation and ADR

GitHub Templates and Workflows

  • Add structured GitHub issue forms for:
    • Bug reports with environment details
    • Feature requests with acceptance criteria
    • Documentation improvements with checklists
  • Add PR templates (both YAML and Markdown) with:
    • Required issue references
    • Detailed change descriptions
    • Testing checklist
    • Breaking change section
  • Update contributing guide with:
    • Issue-based branch naming convention
    • Issue number references in commits
    • Clear forking and PR workflows

Testing Done

  • Verified HelmLogger works with HELM_DEBUG flag
  • Added comprehensive unit tests for logging
  • Manually verified all issue templates render correctly
  • Verified PR template formatting
  • Tested commit message hooks with issue numbers

Type of Change

  • Feature
  • Bug Fix
  • Documentation

Breaking Change

  • No

- Add HelmLogger class diagram to low-level design
- Add logging system documentation
- Create ADR index page for better navigation
- Fix PathData and Value test cases
- Update tasks.md to mark logging implementation complete
- Add structured GitHub issue forms for:
  - Bug reports with environment details
  - Feature requests with acceptance criteria
  - Documentation improvements with checklists
- Update contributing guide with:
  - Issue-based branch naming convention
  - Issue number references in commits
  - Clear forking and PR workflows
- Add YAML-based PR template with:
  - Required issue references
  - Detailed change descriptions
  - Testing checklist
  - Breaking change section
- Add markdown PR template for compatibility
@ritwik-g ritwik-g linked an issue Feb 14, 2025 that may be closed by this pull request
Signed-off-by: Ritwik G <[email protected]>
@ritwik-g ritwik-g merged commit f813b73 into main Feb 14, 2025
6 checks passed
@ritwik-g ritwik-g deleted the 4-add-base-classes-to-represent-the-yaml-structure-without-the-secrets branch February 14, 2025 19:35
@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add base classes to represent the yaml structure (without the secrets)

2 participants